home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 / Ham Radio 2000.iso / ham2000 / packet / bpq408a / progs.doc < prev    next >
Text File  |  1993-09-06  |  11KB  |  334 lines
  1.  
  2. The following programs are provided.
  3.  
  4. BPQCODE.EXE
  5.  
  6.     The TSR version of the packet switch. It provides a NET/ROM compatible
  7.     packet switch, and an interface to application-level software (such as
  8.     a BBS).
  9.  
  10.  
  11. SWITCH.EXE
  12.  
  13.     This is a foreground version of BPQCODE. It is intended to run only as
  14.     a packet switch, and not to support an application system (eg BBS). A
  15.     simple terminal program (equivalent to PAC4) is built in, as is the
  16.     SYSOP handler from the Data Engine version of the switch. The diffences  
  17.     from BPQCODE are listed below:
  18.  
  19.     BPQCFG.TXT
  20.  
  21.     This can be the same as for the normal version. The code will assume
  22.     NODE=1 and BBS=0, whatever is entered. 
  23.  
  24.  
  25.     Terminal support.
  26.  
  27.     See PAC4 below for details. Ctrl/Y shuts down the whole switch.
  28.  
  29.     IPGATE.
  30.  
  31.     SWITCH.EXE includes IPGATE. See IPGATE.DOC for details.
  32.  
  33.     SYSOP Commands.
  34.  
  35.     The SYSOP feature is similar to SYSOPH, but the password protection
  36.     works rather differently. To enter SYSOP mode, enter PASSWORD. If 
  37.     you are using the console, the switch will respond Ok, and enter 
  38.     SYSOP mode. If you are accessing the system remotely, it will respond 
  39.     with 5 random numbers. You must reenter PASSWORD, this time followed 
  40.     by the corresponding characters from the password string contained 
  41.     in the file PASSWORD.BPQ. If these are correct the switch responds 
  42.     OK, otherwise it ignores the message.
  43.  
  44.     So, if the password string is ABCDEFGHIJKLM the following is a
  45.     typical sequence:
  46.  
  47.         PASSWORD
  48.         BPQ:G8BPQ} 04 02 05 06 03
  49.         PASSWORD DBEFC
  50.         BPQ:GBBPQ} Ok
  51.  
  52.     Note that the password is converted to upper case before testing, so 
  53.     PASSWORD.BPQ should contain upper case letters or digits. It should
  54.     not contain spaces or other special characters.
  55.  
  56.     There are a number of extra SYSOP commands. These were added primarily
  57.     for the Data Engine version, where experimenting with parameters is 
  58.     rather more difficult, but I've left them in this version as well.
  59.     
  60.         Command        Corresponding BPQCFG parameter
  61.  
  62.         OBSINIT            OBSINIT
  63.         OBSMIN            OBSMIN
  64.         NODESINT        NODESINTERVAL
  65.         L3TTL            L3TIMETOLIVE 
  66.         L4RETRIES        L4RETRIES
  67.         L4TIMEOUT        L4TIMEOUT
  68.         T3            T3
  69.         IDLETIME        IDLETIME
  70.         LINKEDFLAG        ENABLE_LINKED
  71.         IDINTERVAL        IDINTERVAL
  72.         MINQUAL            MINQUAL
  73.         FULLCTEXT        FULL_CTEXT
  74.         HIDENODES        HIDENODES
  75.         L4DELAY            L4DELAY
  76.         L4WINDOW        L4WINDOW
  77.         BTINTERVAL        BTINTERVAL
  78.  
  79.     There is also one commend which isnt in the DE version - SAVENODES.
  80.  
  81.  
  82. IPGATE.EXE
  83.  
  84.     An IP router to run above the switch (Normally in a DesqView window). See
  85.     IPGATE.DOC for further information.
  86.  
  87.  
  88. ODIDRV.EXE
  89.  
  90.     An EXTERNAL hardware driver to link switches via Ethernet (using Novell's
  91.     ODI interface). See DRIVERS.DOC for further information.
  92.  
  93.  
  94. BPQCFG.EXE
  95.  
  96.     This program converts the configuration file BPQCFG.TXT to a binary file
  97.     (BPQCFG.BIN) for use by the switch software. It must be run after any
  98.     change to BPQCFG.TXT.
  99.  
  100.  
  101.  
  102. BPQNODES.COM
  103.  
  104.  
  105.     This program dump the ROUTES and NODES tables to a file (BPQNODES). This
  106.     file is then used to initialise the above tables when the switch is 
  107.     reloaded. It should be run before reloading the switch, and if possible
  108.     at regular intervals, so that if the system crashes, it comes back with
  109.     a reasonably up-to-date view of the network. Many BBS systems allow you
  110.     to run a program as part of the forwarding cycle, or at specified times.
  111.  
  112.  
  113.     It is possible to edit the BPQNODES file. This provides a way of defining
  114.     Route Qualities, etc. without changing BPQCFG.TXT, or using SYSOPH.
  115.  
  116.     The file format is: ( {} indicates optional entries - don't include the{})
  117.  
  118.     ROUTE ADD CALL P QUAL {!} {VIA DIGI1 {DIGI2}}
  119.  
  120.     where P is the port, QUAL the Quality, and the optional ! indicates a
  121.     locked route. Up to 2 DIGIS may be specified. 
  122.  
  123.     NODE ADD ALIAS:CALL CALL-1 P QUAL {!} {CALL-2 P QUAL {!} } {CALL-3 ....}
  124.  
  125.     where CALL-1, CALL-2, CALL-3 are up to 3 alternate routs, which must be
  126.     defined (by ROUTES config entries or ROUTE ADD) before being used.
  127.  
  128.     Although locked nodes are allowed, I strongly recommend that they are used
  129.     only in exceptional circumstances (eg when using a digi'ed route). Note
  130.     also that a locked route to a node will be removed if the system finds 3 
  131.     higher quality routes to it.
  132.  
  133.  
  134.     Lines beginning with ; are treated as comments, and fields should be
  135.     separated by one (and only one) space.
  136.  
  137.  
  138.  
  139.  
  140. BPQDUMP.COM
  141.  
  142.  
  143.     BPQDUMP.COM  is a simple program to dump my code to a file to aid
  144.     diagnosis of fault conditions. It creates a file in the current directory
  145.     called BPQDUMP (about 98k).
  146.  
  147.     If run without a parameter, it dumps immediately.
  148.  
  149.     If a param is specified, it will loop until the free buffer count drops
  150.     below 20 ( the point when the code starts to shut down), then dumps and
  151.     exits. Note this mode must only be run in a desqview window.
  152.  
  153.  
  154.     eg
  155.  
  156.     BPQDUMP        - dumps now
  157.  
  158.     BPQDUMP X    - dumps when buffers < 21
  159.  
  160.  
  161.  
  162. PAC2.COM
  163.  
  164.  
  165.     PAC2 is a small, simple terminal program, primarily for use with my switch,
  166.     but it also works with a normal TNC + COMBIOS. It has one paramter (port
  167.     number), so enter PAC2 N, where N is the (virtual) COMBIOS port you want
  168.     to access. The program provides a buffered input line, which allows use of
  169.     the editing keys ins, del, cul, cur, etc, It allows logging to disk (CTRL/L
  170.     toggles this function on and off), and maintains a simple 'Response Time
  171.     Monitor' function - useful for seeing how badly the network is performing!
  172.  
  173.     To exit from PAC2, enter CTRL/Y
  174.  
  175.  
  176. PAC4.EXE
  177.  
  178.  
  179.     PAC4 is a simple terminal program, which uses the BPQ Host Mode to talk
  180.     to the switch. The program provides a buffered input line, which allows
  181.     use of the editing keys ins, del, cul, cur, etc. It allows logging to disk
  182.     (CTRL/L toggles this function on and off), and maintains a simple 'Response
  183.     Time Monitor' function. A scroll-back buffer is also provided - use PageUp
  184.     and PageDown to scroll.
  185.  
  186.  
  187.     The program has one required paramter (port number), and a second optional
  188.     one (M for mono mode). So possible command lines are:
  189.  
  190.     PAC4 63            ; to use stream 63
  191.  
  192.     PAC4 1 M        ; to use stream 1, if you have a mono monitor.
  193.  
  194.     Connection is made to the switch when a message is input. The ESC key 
  195.     disconnects you from the switch.
  196.  
  197.     Monitoring is toggled on/off using F1. F2 toggles MCOM mode (monitoring of
  198.     control frames as well as info frames). F3 allows you to set MMASK. Press
  199.     F3, then key up to 4 hex digits, terminated with a newline. Each bit of
  200.     MMASK enables the monitoring of the corresponding radio port. Bit 0 
  201.     enables port 1, bit 15 port 16. Any combination of bits may be set. The 
  202.     current monitor settings are displayed on the status line.
  203.  
  204.  
  205.     To exit from PAC4, enter CTRL/Y
  206.  
  207.  
  208. SYSOPH.COM
  209.  
  210.  
  211.  
  212.     This program allows the manipulation of certain parameters within the
  213.     switch. The program may be run as a normal DOS program, either in a
  214.     Desqview window or standalone, or it may run as a TSR. The TSR mode would
  215.     normally be used if you were running a BBS system that doesnt need 
  216.     DesqView (eg AA4RE). In TSR mode, commands cannot be entered locally, and 
  217.     the SAVENODES command is disabled. It either mode, it may be accessed over
  218.     the network. 
  219.  
  220.     The system has now been modifed to use BPQHOST mode rather than a virtual
  221.     TNC2 port. Program SYSOP.COM is withdrawn.
  222.  
  223.  
  224.     Installation.
  225.  
  226.     1. Add a suitible application name as the third APPLICATIONS Param, ie
  227.  
  228.        APPLICATIONS=BBS,,*SYSOP
  229.  
  230.        I suggest you use a name starting with a '*', as this will 'hide' the
  231.        command from the Valid Commands display.
  232.  
  233.     2« Creatσ ß file¼ PASSWORD.BPQ, containing a string of up to 80 characters.
  234.  
  235.     3. Run program SYSOPH, with a single parameter of the stream to be used,
  236.        either on its own, or in a DesqView window. If a second parameter of
  237.        'RESIDENT' is specified, the program will become a TSR routine.
  238.  
  239.  
  240.  
  241.     Commands may now be entered directly on the PC, (unless in TSR mode) or
  242.     remotely by connecting to the Node, and entering the APPL name (eg *SYSOP). 
  243.     When accessed remotely, a password prompt is sent, containing 5 random
  244.     numbers in the range 1 to the length of the PASSWORD.BPQ string. The first
  245.     command entered must be the corresponding five letters from the password
  246.     string, or the user will be disconnected.
  247.  
  248.     Available Commands.
  249.  
  250.     The following commands are supported:
  251.  
  252.     BYE - Disconnect remote user (even if entered from console)
  253.  
  254.     TXDELAY
  255.     MAXFRAME
  256.     FRACK
  257.     RESPTIME
  258.     PACLEN
  259.     RETRIES
  260.     QUALITY
  261.     PERSIST
  262.     TXTAIL
  263.     XMITOFF
  264.     DIGIFLAG
  265.     DIGIPORT
  266.     USERS
  267.     VALIDCALL
  268.     L3ONLY
  269.     BBSALIAS
  270.     SOFTDCD
  271.     
  272.        The above display or update the parameter for a specified port,
  273.     
  274.        eg   PACLEN 1 100
  275.             PERSIST 2 50
  276.     
  277.        If the third parameter is omitted, the current value is displayed.
  278.     
  279.        Setting XMITOFF will supress all TX activity on a port (including CWID,
  280.        beacons, etc). I put it in so I could monitor the satellites without
  281.        causing QRM, but it could be used as a way of shutting down a port in
  282.        an emergency.
  283.     
  284.        Setting BBSALIAS will cause connects to the port call or port alias to
  285.        go to the BBS rather than the node.
  286.  
  287.    It is not currently possible to update VALIDCALLS, but you can display
  288.    the current setting.
  289.  
  290.  
  291.    *** Warning ***  
  292.  
  293.      At the moment the FRACK value is in 1/3sec units, and the TXDELAY is in
  294.      50ms units for HDLC cards, and 10ms units for KISS TNCs. I'll be sorting
  295.      this out when I get the time to rationalize the timer code, but in the 
  296.      meantime, I suggest you make a note of the current values before you
  297.      start fiddling. 
  298.  
  299.      Also KISS users should note that the params are only sent to the TNC every
  300.      5 mins or so, so the updated values may not take effect for a while.
  301.  
  302.  
  303.    ROUTES
  304.  
  305.        To display ROUTES table, enter ROUTES
  306.  
  307.        To display entry for a particular neighbour, enter ROUTES Call Port,
  308.  
  309.        eg   ROUTES G8BPQ-2 2
  310.  
  311.        To update an entry, enter ROUTES Call Port Params
  312.  
  313.        eg   ROUTES G8BPQ-2 2 100    - Set quality to 100
  314.             ROUTES G8BPQ-2 2 !         - Toggle 'Locked Route' flag
  315.  
  316.        To clear the stats counters on a route, enter:
  317.  
  318.             ROUTES G8BPQ-2 2 Z
  319.  
  320.  
  321.     SAVENODES (Not available in TSR mode).
  322.  
  323.        Writes the ROUTES and NODES tables to the BPQNODES file.
  324.  
  325.        The SAVENODES function may also be invoked directly from the DOS command
  326.        line - this function replaces BPQNODES.COM
  327.  
  328.            ie.  SYSOP SAVENODES
  329.  
  330.  
  331.  
  332. John Wiseman, G8BPQ
  333. 31.8.92
  334.